Prerequisites

• SoftExpert Suite environment hosted in the cloud.
• Previously generated credential to use the Google v2 or v3 API.
• Access to the Configuration > Integration center (COP010) menu.
• "AI features'' permission enabled in Configuration > Access group (CM011) > Other permissions > AI features.

Introduction

Copilot's Integration center features the Integration API tab, which provides the options with which SoftExpert Suite can be integrated, such as Google, Amazon, Zenvia, Twilio, and Azure AI Document Intelligence. 

In addition to these APIs, the SoftExpert Suite offers its own API, called SoftExpert Suite, which provides services equivalent to those of external APIs, with the advantage of not requiring the hiring of third-party suppliers.

Through the Integration API tab, it is also possible to validate the connection with the APIs available in SoftExpert Copilot.

This article will cover the procedure for configuring and validating integration APIs.

Configuring an integration API

1. To configure an Integration API, access the Configuration > Integration center (COP010) menu.

2. In the Integration API tab, the APIs already configured in the system are displayed, with the SoftExpert Suite API being registered by default.

3. Click the button on the sidebar toolbar to add a new Integration API.

4. On the screen that will be opened, fill in the following fields: 

• API: select the desired API among the available options:
  • Google v2: used for text machine translation. To use this API, it is necessary to generate the credential beforehand.
  • Google v3: used for text and file machine translation. To use this API, it is necessary to generate the credential beforehand.
  • Amazon AWS v3: used for text machine translation.
  • Zenvia: used for sending automatic messages via SMS and WhatsApp.
  • Twilio: used for sending automatic messages via SMS and WhatsApp.
  • Azure AI Document Intelligence: used for document data extraction.
• Title: enter an ID # for the API.
• Specific fields: each API option requests specific fields. Fill them in according to the data provided by the integration platforms.

5. After inserting all data, click on the button to finish registering the API.

6. The API will be shown on the list.

Validating integration APIs

1. Access the Configuration > Integration center (COP010) menu.

2. Select the desired API and click on the button.

3. On the screen that will be opened, click on the Validate API button.

4. When clicking on this button, the system will check whether the API is accessible and ready to be used by SoftExpert Copilot, ensuring successful integration.

Conclusion

With the Integration APIs properly configured and validated, it is possible to enable specific translation, notification, and IDP APIs.